<!DOCTYPE HTML>

<html lang="en">
<head>

<title>OAuth2LoginAuthenticationFilter (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="OAuth2LoginAuthenticationFilter (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":10,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="OAuth2LoginAuthenticationFilter.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="OAuth2LoginAuthenticationFilter.html#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="OAuth2LoginAuthenticationFilter.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="OAuth2LoginAuthenticationFilter.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="OAuth2LoginAuthenticationFilter.html#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="OAuth2LoginAuthenticationFilter.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="OAuth2LoginAuthenticationFilter.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.oauth2.client.web</a></div>
<h2 title="Class OAuth2LoginAuthenticationFilter" class="title">Class OAuth2LoginAuthenticationFilter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.springframework.web.filter.GenericFilterBean</li>
<li>
<ul class="inheritance">
<li><a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html" title="class in org.springframework.security.web.authentication">org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter</a></li>
<li>
<ul class="inheritance">
<li>org.springframework.security.oauth2.client.web.OAuth2LoginAuthenticationFilter</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>javax.servlet.Filter</code>, <code>org.springframework.beans.factory.Aware</code>, <code>org.springframework.beans.factory.BeanNameAware</code>, <code>org.springframework.beans.factory.DisposableBean</code>, <code>org.springframework.beans.factory.InitializingBean</code>, <code>org.springframework.context.ApplicationEventPublisherAware</code>, <code>org.springframework.context.EnvironmentAware</code>, <code>org.springframework.context.MessageSourceAware</code>, <code>org.springframework.core.env.EnvironmentCapable</code>, <code>org.springframework.web.context.ServletContextAware</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">OAuth2LoginAuthenticationFilter</span>
extends <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html" title="class in org.springframework.security.web.authentication">AbstractAuthenticationProcessingFilter</a></pre>
<div class="block">An implementation of an <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html" title="class in org.springframework.security.web.authentication"><code>AbstractAuthenticationProcessingFilter</code></a> for OAuth 2.0
Login.
<p>
This authentication <code>Filter</code> handles the processing of an OAuth 2.0 Authorization
Response for the authorization code grant flow and delegates an
<a href="../authentication/OAuth2LoginAuthenticationToken.html" title="class in org.springframework.security.oauth2.client.authentication"><code>OAuth2LoginAuthenticationToken</code></a> to the <a href="../../../authentication/AuthenticationManager.html" title="interface in org.springframework.security.authentication"><code>AuthenticationManager</code></a> to log in
the End-User.
<p>
The OAuth 2.0 Authorization Response is processed as follows:
<ul>
<li>Assuming the End-User (Resource Owner) has granted access to the Client, the
Authorization Server will append the <a href="../../core/endpoint/OAuth2ParameterNames.html#CODE"><code>code</code></a> and
<a href="../../core/endpoint/OAuth2ParameterNames.html#STATE"><code>state</code></a> parameters to the
<a href="../../core/endpoint/OAuth2ParameterNames.html#REDIRECT_URI"><code>redirect_uri</code></a> (provided in the Authorization
Request) and redirect the End-User's user-agent back to this <code>Filter</code> (the
Client).</li>
<li>This <code>Filter</code> will then create an <a href="../authentication/OAuth2LoginAuthenticationToken.html" title="class in org.springframework.security.oauth2.client.authentication"><code>OAuth2LoginAuthenticationToken</code></a> with
the <a href="../../core/endpoint/OAuth2ParameterNames.html#CODE"><code>code</code></a> received and delegate it to the
<a href="../../../authentication/AuthenticationManager.html" title="interface in org.springframework.security.authentication"><code>AuthenticationManager</code></a> to authenticate.</li>
<li>Upon a successful authentication, an <a href="../authentication/OAuth2AuthenticationToken.html" title="class in org.springframework.security.oauth2.client.authentication"><code>OAuth2AuthenticationToken</code></a> is created
(representing the End-User <code>Principal</code>) and associated to the
<a href="../OAuth2AuthorizedClient.html" title="class in org.springframework.security.oauth2.client"><code>Authorized Client</code></a> using the
<a href="OAuth2AuthorizedClientRepository.html" title="interface in org.springframework.security.oauth2.client.web"><code>OAuth2AuthorizedClientRepository</code></a>.</li>
<li>Finally, the <a href="../authentication/OAuth2AuthenticationToken.html" title="class in org.springframework.security.oauth2.client.authentication"><code>OAuth2AuthenticationToken</code></a> is returned and ultimately stored in
the <a href="../../../web/context/SecurityContextRepository.html" title="interface in org.springframework.security.web.context"><code>SecurityContextRepository</code></a> to complete the authentication processing.</li>
</ul></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html" title="class in org.springframework.security.web.authentication"><code>AbstractAuthenticationProcessingFilter</code></a>,
<a href="../authentication/OAuth2LoginAuthenticationToken.html" title="class in org.springframework.security.oauth2.client.authentication"><code>OAuth2LoginAuthenticationToken</code></a>,
<a href="../authentication/OAuth2AuthenticationToken.html" title="class in org.springframework.security.oauth2.client.authentication"><code>OAuth2AuthenticationToken</code></a>,
<a href="../authentication/OAuth2LoginAuthenticationProvider.html" title="class in org.springframework.security.oauth2.client.authentication"><code>OAuth2LoginAuthenticationProvider</code></a>,
<a href="../../core/endpoint/OAuth2AuthorizationRequest.html" title="class in org.springframework.security.oauth2.core.endpoint"><code>OAuth2AuthorizationRequest</code></a>,
<a href="../../core/endpoint/OAuth2AuthorizationResponse.html" title="class in org.springframework.security.oauth2.core.endpoint"><code>OAuth2AuthorizationResponse</code></a>,
<a href="AuthorizationRequestRepository.html" title="interface in org.springframework.security.oauth2.client.web"><code>AuthorizationRequestRepository</code></a>,
<a href="OAuth2AuthorizationRequestRedirectFilter.html" title="class in org.springframework.security.oauth2.client.web"><code>OAuth2AuthorizationRequestRedirectFilter</code></a>,
<a href="../registration/ClientRegistrationRepository.html" title="interface in org.springframework.security.oauth2.client.registration"><code>ClientRegistrationRepository</code></a>,
<a href="../OAuth2AuthorizedClient.html" title="class in org.springframework.security.oauth2.client"><code>OAuth2AuthorizedClient</code></a>,
<a href="OAuth2AuthorizedClientRepository.html" title="interface in org.springframework.security.oauth2.client.web"><code>OAuth2AuthorizedClientRepository</code></a>,
<a target="_blank" href="https://tools.ietf.org/html/rfc6749#section-4.1">Section
4.1 Authorization Code Grant</a>,
<a target="_blank" href="https://tools.ietf.org/html/rfc6749#section-4.1.2">Section 4.1.2 Authorization
Response</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">

</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2LoginAuthenticationFilter.html#DEFAULT_FILTER_PROCESSES_URI">DEFAULT_FILTER_PROCESSES_URI</a></span></code></th>
<td class="colLast">
<div class="block">The default <code>URI</code> where this <code>Filter</code> processes authentication
requests.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter">

</a>
<h3>Fields inherited from class&nbsp;org.springframework.security.web.authentication.<a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html" title="class in org.springframework.security.web.authentication">AbstractAuthenticationProcessingFilter</a></h3>
<code><a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#authenticationDetailsSource">authenticationDetailsSource</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#eventPublisher">eventPublisher</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#messages">messages</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.springframework.web.filter.GenericFilterBean">

</a>
<h3>Fields inherited from class&nbsp;org.springframework.web.filter.GenericFilterBean</h3>
<code>logger</code></li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">

</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="OAuth2LoginAuthenticationFilter.html#%3Cinit%3E(org.springframework.security.oauth2.client.registration.ClientRegistrationRepository,org.springframework.security.oauth2.client.OAuth2AuthorizedClientService)">OAuth2LoginAuthenticationFilter</a></span>&#8203;(<a href="../registration/ClientRegistrationRepository.html" title="interface in org.springframework.security.oauth2.client.registration">ClientRegistrationRepository</a>&nbsp;clientRegistrationRepository,
<a href="../OAuth2AuthorizedClientService.html" title="interface in org.springframework.security.oauth2.client">OAuth2AuthorizedClientService</a>&nbsp;authorizedClientService)</code></th>
<td class="colLast">
<div class="block">Constructs an <code>OAuth2LoginAuthenticationFilter</code> using the provided
parameters.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="OAuth2LoginAuthenticationFilter.html#%3Cinit%3E(org.springframework.security.oauth2.client.registration.ClientRegistrationRepository,org.springframework.security.oauth2.client.OAuth2AuthorizedClientService,java.lang.String)">OAuth2LoginAuthenticationFilter</a></span>&#8203;(<a href="../registration/ClientRegistrationRepository.html" title="interface in org.springframework.security.oauth2.client.registration">ClientRegistrationRepository</a>&nbsp;clientRegistrationRepository,
<a href="../OAuth2AuthorizedClientService.html" title="interface in org.springframework.security.oauth2.client">OAuth2AuthorizedClientService</a>&nbsp;authorizedClientService,
java.lang.String&nbsp;filterProcessesUrl)</code></th>
<td class="colLast">
<div class="block">Constructs an <code>OAuth2LoginAuthenticationFilter</code> using the provided
parameters.</div>
</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="OAuth2LoginAuthenticationFilter.html#%3Cinit%3E(org.springframework.security.oauth2.client.registration.ClientRegistrationRepository,org.springframework.security.oauth2.client.web.OAuth2AuthorizedClientRepository,java.lang.String)">OAuth2LoginAuthenticationFilter</a></span>&#8203;(<a href="../registration/ClientRegistrationRepository.html" title="interface in org.springframework.security.oauth2.client.registration">ClientRegistrationRepository</a>&nbsp;clientRegistrationRepository,
<a href="OAuth2AuthorizedClientRepository.html" title="interface in org.springframework.security.oauth2.client.web">OAuth2AuthorizedClientRepository</a>&nbsp;authorizedClientRepository,
java.lang.String&nbsp;filterProcessesUrl)</code></th>
<td class="colLast">
<div class="block">Constructs an <code>OAuth2LoginAuthenticationFilter</code> using the provided
parameters.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2LoginAuthenticationFilter.html#attemptAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">attemptAuthentication</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</code></th>
<td class="colLast">
<div class="block">Performs actual authentication.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2LoginAuthenticationFilter.html#setAuthenticationResultConverter(org.springframework.core.convert.converter.Converter)">setAuthenticationResultConverter</a></span>&#8203;(org.springframework.core.convert.converter.Converter&lt;<a href="../authentication/OAuth2LoginAuthenticationToken.html" title="class in org.springframework.security.oauth2.client.authentication">OAuth2LoginAuthenticationToken</a>,&#8203;<a href="../authentication/OAuth2AuthenticationToken.html" title="class in org.springframework.security.oauth2.client.authentication">OAuth2AuthenticationToken</a>&gt;&nbsp;authenticationResultConverter)</code></th>
<td class="colLast">
<div class="block">Sets the converter responsible for converting from
<a href="../authentication/OAuth2LoginAuthenticationToken.html" title="class in org.springframework.security.oauth2.client.authentication"><code>OAuth2LoginAuthenticationToken</code></a> to <a href="../authentication/OAuth2AuthenticationToken.html" title="class in org.springframework.security.oauth2.client.authentication"><code>OAuth2AuthenticationToken</code></a>
authentication result.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OAuth2LoginAuthenticationFilter.html#setAuthorizationRequestRepository(org.springframework.security.oauth2.client.web.AuthorizationRequestRepository)">setAuthorizationRequestRepository</a></span>&#8203;(<a href="AuthorizationRequestRepository.html" title="interface in org.springframework.security.oauth2.client.web">AuthorizationRequestRepository</a>&lt;<a href="../../core/endpoint/OAuth2AuthorizationRequest.html" title="class in org.springframework.security.oauth2.core.endpoint">OAuth2AuthorizationRequest</a>&gt;&nbsp;authorizationRequestRepository)</code></th>
<td class="colLast">
<div class="block">Sets the repository for stored <a href="../../core/endpoint/OAuth2AuthorizationRequest.html" title="class in org.springframework.security.oauth2.core.endpoint"><code>OAuth2AuthorizationRequest</code></a>'s.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter">

</a>
<h3>Methods inherited from class&nbsp;org.springframework.security.web.authentication.<a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html" title="class in org.springframework.security.web.authentication">AbstractAuthenticationProcessingFilter</a></h3>
<code><a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#afterPropertiesSet()">afterPropertiesSet</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#doFilter(javax.servlet.ServletRequest,javax.servlet.ServletResponse,javax.servlet.FilterChain)">doFilter</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#getAllowSessionCreation()">getAllowSessionCreation</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#getAuthenticationManager()">getAuthenticationManager</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#getFailureHandler()">getFailureHandler</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#getRememberMeServices()">getRememberMeServices</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#getSuccessHandler()">getSuccessHandler</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#requiresAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">requiresAuthentication</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#setAllowSessionCreation(boolean)">setAllowSessionCreation</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher)">setApplicationEventPublisher</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#setAuthenticationDetailsSource(org.springframework.security.authentication.AuthenticationDetailsSource)">setAuthenticationDetailsSource</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#setAuthenticationFailureHandler(org.springframework.security.web.authentication.AuthenticationFailureHandler)">setAuthenticationFailureHandler</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#setAuthenticationManager(org.springframework.security.authentication.AuthenticationManager)">setAuthenticationManager</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#setAuthenticationSuccessHandler(org.springframework.security.web.authentication.AuthenticationSuccessHandler)">setAuthenticationSuccessHandler</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#setContinueChainBeforeSuccessfulAuthentication(boolean)">setContinueChainBeforeSuccessfulAuthentication</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#setFilterProcessesUrl(java.lang.String)">setFilterProcessesUrl</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#setMessageSource(org.springframework.context.MessageSource)">setMessageSource</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#setRememberMeServices(org.springframework.security.web.authentication.RememberMeServices)">setRememberMeServices</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#setRequiresAuthenticationRequestMatcher(org.springframework.security.web.util.matcher.RequestMatcher)">setRequiresAuthenticationRequestMatcher</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#setSessionAuthenticationStrategy(org.springframework.security.web.authentication.session.SessionAuthenticationStrategy)">setSessionAuthenticationStrategy</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#successfulAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,javax.servlet.FilterChain,org.springframework.security.core.Authentication)">successfulAuthentication</a>, <a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#unsuccessfulAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.AuthenticationException)">unsuccessfulAuthentication</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.springframework.web.filter.GenericFilterBean">

</a>
<h3>Methods inherited from class&nbsp;org.springframework.web.filter.GenericFilterBean</h3>
<code>addRequiredProperty, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">

</a>
<h3>Field Detail</h3>
<a id="DEFAULT_FILTER_PROCESSES_URI">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_FILTER_PROCESSES_URI</h4>
<pre>public static final&nbsp;java.lang.String DEFAULT_FILTER_PROCESSES_URI</pre>
<div class="block">The default <code>URI</code> where this <code>Filter</code> processes authentication
requests.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.springframework.security.oauth2.client.web.OAuth2LoginAuthenticationFilter.DEFAULT_FILTER_PROCESSES_URI">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">

</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.springframework.security.oauth2.client.registration.ClientRegistrationRepository,org.springframework.security.oauth2.client.OAuth2AuthorizedClientService)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>OAuth2LoginAuthenticationFilter</h4>
<pre>public&nbsp;OAuth2LoginAuthenticationFilter&#8203;(<a href="../registration/ClientRegistrationRepository.html" title="interface in org.springframework.security.oauth2.client.registration">ClientRegistrationRepository</a>&nbsp;clientRegistrationRepository,
                                       <a href="../OAuth2AuthorizedClientService.html" title="interface in org.springframework.security.oauth2.client">OAuth2AuthorizedClientService</a>&nbsp;authorizedClientService)</pre>
<div class="block">Constructs an <code>OAuth2LoginAuthenticationFilter</code> using the provided
parameters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clientRegistrationRepository</code> - the repository of client registrations</dd>
<dd><code>authorizedClientService</code> - the authorized client service</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.springframework.security.oauth2.client.registration.ClientRegistrationRepository,org.springframework.security.oauth2.client.OAuth2AuthorizedClientService,java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>OAuth2LoginAuthenticationFilter</h4>
<pre>public&nbsp;OAuth2LoginAuthenticationFilter&#8203;(<a href="../registration/ClientRegistrationRepository.html" title="interface in org.springframework.security.oauth2.client.registration">ClientRegistrationRepository</a>&nbsp;clientRegistrationRepository,
                                       <a href="../OAuth2AuthorizedClientService.html" title="interface in org.springframework.security.oauth2.client">OAuth2AuthorizedClientService</a>&nbsp;authorizedClientService,
                                       java.lang.String&nbsp;filterProcessesUrl)</pre>
<div class="block">Constructs an <code>OAuth2LoginAuthenticationFilter</code> using the provided
parameters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clientRegistrationRepository</code> - the repository of client registrations</dd>
<dd><code>authorizedClientService</code> - the authorized client service</dd>
<dd><code>filterProcessesUrl</code> - the <code>URI</code> where this <code>Filter</code> will process
the authentication requests</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.springframework.security.oauth2.client.registration.ClientRegistrationRepository,org.springframework.security.oauth2.client.web.OAuth2AuthorizedClientRepository,java.lang.String)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OAuth2LoginAuthenticationFilter</h4>
<pre>public&nbsp;OAuth2LoginAuthenticationFilter&#8203;(<a href="../registration/ClientRegistrationRepository.html" title="interface in org.springframework.security.oauth2.client.registration">ClientRegistrationRepository</a>&nbsp;clientRegistrationRepository,
                                       <a href="OAuth2AuthorizedClientRepository.html" title="interface in org.springframework.security.oauth2.client.web">OAuth2AuthorizedClientRepository</a>&nbsp;authorizedClientRepository,
                                       java.lang.String&nbsp;filterProcessesUrl)</pre>
<div class="block">Constructs an <code>OAuth2LoginAuthenticationFilter</code> using the provided
parameters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clientRegistrationRepository</code> - the repository of client registrations</dd>
<dd><code>authorizedClientRepository</code> - the authorized client repository</dd>
<dd><code>filterProcessesUrl</code> - the <code>URI</code> where this <code>Filter</code> will process
the authentication requests</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.1</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">

</a>
<h3>Method Detail</h3>
<a id="attemptAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>attemptAuthentication</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a>&nbsp;attemptAuthentication&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
                                            javax.servlet.http.HttpServletResponse&nbsp;response)
                                     throws <a href="../../../core/AuthenticationException.html" title="class in org.springframework.security.core">AuthenticationException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#attemptAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">AbstractAuthenticationProcessingFilter</a></code></span></div>
<div class="block">Performs actual authentication.
<p>
The implementation should do one of the following:
<ol>
<li>Return a populated authentication token for the authenticated user, indicating
successful authentication</li>
<li>Return null, indicating that the authentication process is still in progress.
Before returning, the implementation should perform any additional work required to
complete the process.</li>
<li>Throw an <tt>AuthenticationException</tt> if the authentication process
fails</li>
</ol></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html#attemptAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">attemptAuthentication</a></code>&nbsp;in class&nbsp;<code><a href="../../../web/authentication/AbstractAuthenticationProcessingFilter.html" title="class in org.springframework.security.web.authentication">AbstractAuthenticationProcessingFilter</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - from which to extract parameters and perform the authentication</dd>
<dd><code>response</code> - the response, which may be needed if the implementation has to do a
redirect as part of a multi-stage authentication process (such as OpenID).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the authenticated user token, or null if authentication is incomplete.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../core/AuthenticationException.html" title="class in org.springframework.security.core">AuthenticationException</a></code> - if authentication fails.</dd>
</dl>
</li>
</ul>
<a id="setAuthorizationRequestRepository(org.springframework.security.oauth2.client.web.AuthorizationRequestRepository)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setAuthorizationRequestRepository</h4>
<pre class="methodSignature">public final&nbsp;void&nbsp;setAuthorizationRequestRepository&#8203;(<a href="AuthorizationRequestRepository.html" title="interface in org.springframework.security.oauth2.client.web">AuthorizationRequestRepository</a>&lt;<a href="../../core/endpoint/OAuth2AuthorizationRequest.html" title="class in org.springframework.security.oauth2.core.endpoint">OAuth2AuthorizationRequest</a>&gt;&nbsp;authorizationRequestRepository)</pre>
<div class="block">Sets the repository for stored <a href="../../core/endpoint/OAuth2AuthorizationRequest.html" title="class in org.springframework.security.oauth2.core.endpoint"><code>OAuth2AuthorizationRequest</code></a>'s.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authorizationRequestRepository</code> - the repository for stored
<a href="../../core/endpoint/OAuth2AuthorizationRequest.html" title="class in org.springframework.security.oauth2.core.endpoint"><code>OAuth2AuthorizationRequest</code></a>'s</dd>
</dl>
</li>
</ul>
<a id="setAuthenticationResultConverter(org.springframework.core.convert.converter.Converter)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setAuthenticationResultConverter</h4>
<pre class="methodSignature">public final&nbsp;void&nbsp;setAuthenticationResultConverter&#8203;(org.springframework.core.convert.converter.Converter&lt;<a href="../authentication/OAuth2LoginAuthenticationToken.html" title="class in org.springframework.security.oauth2.client.authentication">OAuth2LoginAuthenticationToken</a>,&#8203;<a href="../authentication/OAuth2AuthenticationToken.html" title="class in org.springframework.security.oauth2.client.authentication">OAuth2AuthenticationToken</a>&gt;&nbsp;authenticationResultConverter)</pre>
<div class="block">Sets the converter responsible for converting from
<a href="../authentication/OAuth2LoginAuthenticationToken.html" title="class in org.springframework.security.oauth2.client.authentication"><code>OAuth2LoginAuthenticationToken</code></a> to <a href="../authentication/OAuth2AuthenticationToken.html" title="class in org.springframework.security.oauth2.client.authentication"><code>OAuth2AuthenticationToken</code></a>
authentication result.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authenticationResultConverter</code> - the converter for
<a href="../authentication/OAuth2AuthenticationToken.html" title="class in org.springframework.security.oauth2.client.authentication"><code>OAuth2AuthenticationToken</code></a>'s</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.6</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="OAuth2LoginAuthenticationFilter.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="OAuth2LoginAuthenticationFilter.html#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="OAuth2LoginAuthenticationFilter.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="OAuth2LoginAuthenticationFilter.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="OAuth2LoginAuthenticationFilter.html#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="OAuth2LoginAuthenticationFilter.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="OAuth2LoginAuthenticationFilter.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040dda86a0f97cf","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
